Fix readthedocs copyright year, add link to docs when calling openfast help #3015
Conversation
**************************************************************************************************
OpenFAST
Copyright (C) 2025 National Renewable Energy Laboratory
Copyright (C) 2025 Envision Energy USA LTD
This program is licensed under Apache License Version 2.0 and comes with ABSOLUTELY NO WARRANTY.
See the "LICENSE" file distributed with this software for details.
**************************************************************************************************
OpenFAST-v4.1.2
Compile Info:
- Compiler: GCC version 14.3.0
- Architecture: 64 bit
- Precision: single
- OpenMP: No
- Date: Aug 7 2025
- Time: 14:27:18
Execution Info:
- Date: 09/29/2025
- Time: 15:44:47-0600
Syntax is:
OpenFAST [-h] <InputFile>
where:
-h generates this help message.
<InputFile> is the name of the required primary input file.
Note: values enclosed in square brackets [] are optional. Do not enter the brackets.
OpenFAST terminated normally.
mayankchetan
requested review from
andrew-platt and
Copilot
and removed request for
andrew-platt
There was a problem hiding this comment.
Pull Request Overview
This PR updates the OpenFAST documentation and help system by making the copyright year dynamic and adding a reference link to the documentation. The changes ensure the copyright year in ReadTheDocs automatically updates each year and provides users with easy access to documentation when using the help command.
- Dynamic copyright year calculation using current date
- Added documentation link in help output for better user guidance
- Converted static strings to f-strings for consistency
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/conf.py | Updates copyright year to be dynamic and converts strings to f-strings |
| modules/nwtc-library/src/NWTC_IO.f90 | Adds ReadTheDocs link to help command output |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| project = f'OpenFAST' | ||
| copyright = f'{datetime.date.today().year}, National Renewable Energy Laboratory' | ||
| author = f'OpenFAST Team' |
There was a problem hiding this comment.
The f-string conversion for project and author variables is unnecessary since they contain only static strings without any interpolation. Consider keeping them as regular strings for clarity: project = 'OpenFAST' and author = 'OpenFAST Team'.
| project = f'OpenFAST' | |
| copyright = f'{datetime.date.today().year}, National Renewable Energy Laboratory' | |
| author = f'OpenFAST Team' | |
| project = 'OpenFAST' | |
| copyright = f'{datetime.date.today().year}, National Renewable Energy Laboratory' | |
| author = 'OpenFAST Team' |
| version = f'4.1' | ||
| # The full version, including alpha/beta/rc tags. | ||
| release = u'v4.1.2' | ||
| release = f'v4.1.2' |
There was a problem hiding this comment.
Converting version and release to f-strings is unnecessary since they contain only static strings. Consider keeping them as regular strings: version = '4.1' and release = 'v4.1.2'.
mayankchetan
changed the title
2 participants
Feature or improvement description
Fixing the "© Copyright , National Renewable Energy Laboratory." tags at the bottom of read the docs pages to update programmatically.
Added a link to https://openfast.readthedocs.io/ when user passes
-hto the openfast executableRelated issue, if one exists
None
Impacted areas of the software
Additional supporting information
Test results, if applicable
Docs build successfully on local machine.